Overview

The BlinkReceipt E-Receipt API lets you extract structured purchase data from retailer confirmation emails. You supply raw email content (EML format) or configure per-retailer scraping, and the API returns a normalized receipt object containing line-item products, totals, merchant details, order status, and more.

What the API Does

• Parses retailer order-confirmation emails into structured receipt data
• Supports template-based and generic parsing methods
• Authenticates emails via DKIM/SPF verification
• Aggregates multi-email order flows into a single receipt
• Delivers parsed results asynchronously to your configured webhook endpoint

Base URLs

Environment	Base URL
Sandbox	https://sandbox.blinkreceipt.com
Production	https://scan.blinkreceipt.com

Use the sandbox environment for development and testing. Switch to the production URL when you are ready to go live.

Authentication

Every request must include your API key in the api-key request header.

api-key: YOUR_API_KEY

If the key is missing or invalid, the API returns error code 101.

High-Level Workflow

1. Configure your account — set a webhook (results_endpoint) and optionally define per-retailer cutoff windows. See configuration.md.
2. Create a job — POST an EML email to /ereceipts/create_job. The API queues a scrape job and returns a job_id.
3. Poll for status (optional) — GET /ereceipts/status?job_id=<id> to check whether the job is queued, executing, completed, or error.
4. Receive results — When the job completes, the API POSTs the parsed receipt data to your configured results_endpoint webhook.

For a step-by-step guide, see getting-started.md. For the full endpoint reference, see endpoints.md. For the complete response schema, see response-structure.md.